Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CONTRIBUTING I have changed line 35 of eslintrc.js based on the issue #313 #839

Merged
merged 3 commits into from
Aug 7, 2024

Conversation

AymarN
Copy link
Contributor

@AymarN AymarN commented Aug 1, 2024

What kind of change does this PR introduce?
The line 35 of eslintrc has been changed.

826:

  • Closes #313
  • Related to #826
  • Others?

Screenshots/videos:
Screenshot -1
Problem -1
Solution - 1

If relevant, did you update the documentation?

Summary
There is a set up issue on windows once the installation guide is followed. An error is generated:
Expected linebreaks to be 'LF' but found 'CRLF' On Windows.
313
#826
Does this PR introduce a breaking change?

That affects the set up on Unix computers and on Windows.

@AymarN AymarN requested a review from a team as a code owner August 1, 2024 17:56
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to the JSON Schema Community. Thanks a lot for creating your first pull request!! 🎉🎉 We are so excited you are here! We hope this is only the first of many! For more details check out README.md file.

Copy link

github-actions bot commented Aug 1, 2024

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
website ✅ Ready (View Log) Visit Preview 2119820

@gregsdennis
Copy link
Member

Why do we think an ADR is required for this? It seems like such a small thing.

@AymarN
Copy link
Contributor Author

AymarN commented Aug 1, 2024

Why do we think an ADR is required for this? It seems like such a small thing.

Thank you for asking. I believe the problem was resolved through issue #313 . However it has not been changed in the source code. That affects the set up on Windows and very likely on Unix computers. The line shall be changed so that the lint tests go through along with the cypress tests. Besides, the installation guide may mention that Visual Studio Code is the IDE which matches with the project. Afterwards, if a pull request has an issue associated with it, it should inherit present ad-required labels.(CONTRIBUTING.md)

@gregsdennis
Copy link
Member

ADRs are for (generally large and impactful) topics which have been thoroughly discussed and a vote or some other mechanism has been utilized to make a final decision. The ADR then documents that decision.

I don't think that line terminations in the website code fit that requirement.


Why not update CONTRIBUTING as part of this PR? You're making the change here, we should go ahead and update the instructions to others. It should also be part of the build so that the build fails if the code's not correct (if it's not doing that already).

@AymarN AymarN changed the title adr-required I have changed line 35 of eslintrc.js based on the issue #313 CONTRIBUTING I have changed line 35 of eslintrc.js based on the issue #313 Aug 1, 2024
@AymarN
Copy link
Contributor Author

AymarN commented Aug 1, 2024

ADRs are for (generally large and impactful) topics which have been thoroughly discussed and a vote or some other mechanism has been utilized to make a final decision. The ADR then documents that decision.

I don't think that line terminations in the website code fit that requirement.

Why not update CONTRIBUTING as part of this PR? You're making the change here, we should go ahead and update the instructions to others. It should also be part of the build so that the build fails if the code's not correct (if it's not doing that already).

Thank you for your recommendation. Are there any blockers to merge ?

@gregsdennis
Copy link
Member

This needs someone more familiar with the build tools than me. cc: @jdesrosiers / @benjagm

Copy link
Member

@jdesrosiers jdesrosiers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks ok to me.

Copy link
Collaborator

@aialok aialok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

Thank you @AymarN : )

Copy link
Collaborator

@benjagm benjagm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for putting this together! The change in eslintrc.js looks good, however all the changes in the getting started examples should be removed from this PR.

Copy link

codecov bot commented Aug 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@f6dff53). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff            @@
##             main      #839   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?         1           
  Lines           ?        20           
  Branches        ?        12           
========================================
  Hits            ?        20           
  Misses          ?         0           
  Partials        ?         0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@AymarN
Copy link
Contributor Author

AymarN commented Aug 7, 2024

Thanks a lot for putting this together! The change in eslintrc.js looks good, however all the changes in the getting started examples should be removed from this PR.

Thank you. I updated the branch and hoping for your approval.

@benjagm benjagm merged commit ee75189 into json-schema-org:main Aug 7, 2024
8 of 9 checks passed
Copy link

github-actions bot commented Aug 7, 2024

Congratulations, @AymarN for your first pull request merge in this repository! 🎉🎉. Thanks for your contribution to JSON Schema!

@benjagm
Copy link
Collaborator

benjagm commented Aug 7, 2024

Congrats on merging your first Pull Request!!

@AymarN AymarN deleted the issue_826_313_ASN branch August 10, 2024 02:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants